SureTax Returns API

POST Regenerate Form Instance

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This endpoint is used to regenerate a specific form instance based on the latest data or configuration. This action is typically performed when a form needs to be updated with new information or recalculated due to changes in the source data or settings. The regeneration process overwrites the existing form instance with the newly generated one

OperationId: POST Regenerate Form Instance

Authorization Method(s): OAuth

Verb: POST

End Point: /api/v1/Forms/RegenerateFormInstance

Request Body

OVERVIEWEXAMPLE

Request Model

Display Name	Field Name	Field Type
Data	data	RegenerateFormInstanceRequest

RegenerateFormInstanceRequest

Display Name	Field Name	Field Type
Id	id	string

Example Request

{
  "data": {
    "id": "string"
  }
}

Request Headers

Display String	Field Name	Field Type
X-request-id*	x-request-id	string

*Mandatory parameter

Response Codes

code	description
202	The API responds with this code to indicate that the data was sent successfully.
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	401 Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/RegenerateFormInstance

Add Request Headers:

{
  "data": {
    "id": "string"
  }
}